Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix: handle async process.exit #8103

Draft
wants to merge 6 commits into
base: next
Choose a base branch
from
Draft

fix: handle async process.exit #8103

wants to merge 6 commits into from

Conversation

EoinFalconer
Copy link
Contributor

Description

Found this interesting issue when looking into SAPP-1966. The process.exit function in the CLI is monkey patched so we can send telemetry before the process ends. This is fine in all other cases in cli.ts except for when we are checking whether the command is to simply check the version using the --version or -v flag.

I think that this is a bit dangerous to monkey patch process.env especially in a cli environment (the comment remarks this) so I thought I would give it a go to refactor a bit. We could obviously just add a return statement after the process.exit call in question but it seems like a recipe for problems if you go about using process.exit in some other file and assume that your code will stop executing at that point, but it won't.

What to review

Is the approach ok? Happy to just leave the return or go ahead and create some sort of async process.exit() set-up, but it feels the risk is bigger than the reward.

Testing

Added a test, tell me if it is in the wrong place.

Notes for release

Not worth it.

@EoinFalconer EoinFalconer requested a review from a team as a code owner December 18, 2024 20:43
@EoinFalconer EoinFalconer requested review from ricokahler and removed request for a team December 18, 2024 20:43
@vercel Vercel
Copy link

vercel bot commented Dec 18, 2024 •
edited
Loading

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
page-building-studio ✅ Ready (Inspect) Visit Preview 💬 Add feedback Dec 18, 2024 9:40pm
performance-studio ✅ Ready (Inspect) Visit Preview 💬 Add feedback Dec 18, 2024 9:40pm
test-next-studio ✅ Ready (Inspect) Visit Preview 💬 Add feedback Dec 18, 2024 9:40pm
test-studio ✅ Ready (Inspect) Visit Preview 💬 Add feedback Dec 18, 2024 9:40pm
1 Skipped Deployment
Name Status Preview Comments Updated (UTC)
studio-workshop ⬜️ Ignored (Inspect) Visit Preview Dec 18, 2024 9:40pm

@github-actions GitHub Actions
Copy link
Contributor

No changes to documentation

@EoinFalconer EoinFalconer marked this pull request as draft December 18, 2024 20:53
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Dec 18, 2024 •
edited
Loading

Component Testing Report Updated Dec 18, 2024 9:30 PM (UTC)

✅ All Tests Passed -- expand for details
File Status Duration Passed Skipped Failed
comments/CommentInput.spec.tsx ✅ Passed (Inspect) 1m 11s 15 0 0
formBuilder/ArrayInput.spec.tsx ✅ Passed (Inspect) 14s 3 0 0
formBuilder/inputs/PortableText/Annotations.spec.tsx ✅ Passed (Inspect) 41s 6 0 0
formBuilder/inputs/PortableText/copyPaste/CopyPaste.spec.tsx ✅ Passed (Inspect) 55s 11 7 0
formBuilder/inputs/PortableText/copyPaste/CopyPasteFields.spec.tsx ✅ Passed (Inspect) 0s 0 12 0
formBuilder/inputs/PortableText/Decorators.spec.tsx ✅ Passed (Inspect) 29s 6 0 0
formBuilder/inputs/PortableText/DisableFocusAndUnset.spec.tsx ✅ Passed (Inspect) 16s 3 0 0
formBuilder/inputs/PortableText/DragAndDrop.spec.tsx ✅ Passed (Inspect) 30s 6 0 0
formBuilder/inputs/PortableText/FocusTracking.spec.tsx ✅ Passed (Inspect) 1m 15s 15 0 0
formBuilder/inputs/PortableText/Input.spec.tsx ✅ Passed (Inspect) 1m 36s 21 0 0
formBuilder/inputs/PortableText/ObjectBlock.spec.tsx ✅ Passed (Inspect) 1m 47s 18 0 0
formBuilder/inputs/PortableText/PresenceCursors.spec.tsx ✅ Passed (Inspect) 14s 3 9 0
formBuilder/inputs/PortableText/Styles.spec.tsx ✅ Passed (Inspect) 29s 6 0 0
formBuilder/inputs/PortableText/Toolbar.spec.tsx ✅ Passed (Inspect) 1m 52s 21 0 0
formBuilder/tree-editing/TreeEditing.spec.tsx ✅ Passed (Inspect) 0s 0 3 0
formBuilder/tree-editing/TreeEditingNestedObjects.spec.tsx ✅ Passed (Inspect) 0s 0 3 0

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Dec 18, 2024 •
edited
Loading

⚡️ Editor Performance Report

Updated Wed, 18 Dec 2024 21:31:54 GMT

Benchmark reference
latency of sanity@latest		 experiment
latency of this branch		 Δ (%)
latency difference
recipe (name) 55.6 efps (18ms) 55.6 efps (18ms) +0ms (-/-%) ✅
recipe (description) 62.5 efps (16ms) 62.5 efps (16ms) +0ms (-/-%) ✅
recipe (instructions) 99.9+ efps (5ms) 99.9+ efps (5ms) +0ms (-/-%) ✅
synthetic (title) 19.6 efps (51ms) 19.6 efps (51ms) +0ms (-/-%) ✅
synthetic (string inside object) 18.9 efps (53ms) 18.9 efps (53ms) +0ms (-/-%) ✅

efps — editor "frames per second". The number of updates assumed to be possible within a second.

Derived from input latency. efps = 1000 / input_latency

Detailed information

🏠 Reference result

The performance result of sanity@latest

Benchmark latency p75 p90 p99 blocking time test duration
recipe (name) 18ms 20ms 22ms 38ms 0ms 7.1s
recipe (description) 16ms 17ms 19ms 36ms 0ms 4.4s
recipe (instructions) 5ms 6ms 8ms 34ms 0ms 3.1s
synthetic (title) 51ms 52ms 55ms 62ms 164ms 12.6s
synthetic (string inside object) 53ms 56ms 62ms 411ms 791ms 8.2s

🧪 Experiment result

The performance result of this branch

Benchmark latency p75 p90 p99 blocking time test duration
recipe (name) 18ms 20ms 22ms 31ms 0ms 6.7s
recipe (description) 16ms 18ms 20ms 29ms 0ms 4.3s
recipe (instructions) 5ms 6ms 7ms 39ms 0ms 3.1s
synthetic (title) 51ms 53ms 59ms 289ms 534ms 13.3s
synthetic (string inside object) 53ms 57ms 72ms 471ms 898ms 9.0s

📚 Glossary

column definitions

  • benchmark — the name of the test, e.g. "article", followed by the label of the field being measured, e.g. "(title)".
  • latency — the time between when a key was pressed and when it was rendered. derived from a set of samples. the median (p50) is shown to show the most common latency.
  • p75 — the 75th percentile of the input latency in the test run. 75% of the sampled inputs in this benchmark were processed faster than this value. this provides insight into the upper range of typical performance.
  • p90 — the 90th percentile of the input latency in the test run. 90% of the sampled inputs were faster than this. this metric helps identify slower interactions that occurred less frequently during the benchmark.
  • p99 — the 99th percentile of the input latency in the test run. only 1% of sampled inputs were slower than this. this represents the worst-case scenarios encountered during the benchmark, useful for identifying potential performance outliers.
  • blocking time — the total time during which the main thread was blocked, preventing user input and UI updates. this metric helps identify performance bottlenecks that may cause the interface to feel unresponsive.
  • test duration — how long the test run took to complete.

@EoinFalconer EoinFalconer changed the title Fix/sapp 1966 fix: handle async process.exit Dec 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ricokahler ricokahler Awaiting requested review from ricokahler ricokahler is a code owner automatically assigned from sanity-io/studio

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@EoinFalconer